-
Notifications
You must be signed in to change notification settings - Fork 30.7k
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
doc: fix api docs style #13700
doc: fix api docs style #13700
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit & Question
@@ -2854,7 +2854,6 @@ The following constants are meant for use with the [`fs.Stats`][] object's | |||
[Caveats]: #fs_caveats | |||
[Common System Errors]: errors.html#errors_common_system_errors | |||
[FS Constants]: #fs_fs_constants_1 | |||
[MDN-Date-getTime]: https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Date/getTime |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question: This one's my miss (#13173). Did you use a tool to find it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I did use mdlint
that has been implementing at #12756.
doc/api/async_hooks.md
Outdated
@@ -195,7 +195,7 @@ The `type` is a string that represents the type of resource that caused | |||
`init` to be called. Generally it will correspond the name of the resource's | |||
constructor. | |||
|
|||
``` | |||
```csv |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: I think YAML
or even simply text
is more correct...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The values in this part are separated only by a comma, but I agree on using text
since it's not a data for csv/yaml. Will do! Thanks :)
aacd268
to
046a21a
Compare
doc/api/async_hooks.md + L198: Missing code-language flag + L239: Missing code-language flag + L317: Missing code-language flag + L347: Missing code-language flag doc/api/fs.md + L2857: Unused definition PR-URL: nodejs#13700 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
046a21a
to
d6edc6d
Compare
Landed in 4ca3b9c. Thanks. |
doc/api/async_hooks.md + L198: Missing code-language flag + L239: Missing code-language flag + L317: Missing code-language flag + L347: Missing code-language flag doc/api/fs.md + L2857: Unused definition PR-URL: #13700 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
doc/api/async_hooks.md + L198: Missing code-language flag + L239: Missing code-language flag + L317: Missing code-language flag + L347: Missing code-language flag doc/api/fs.md + L2857: Unused definition PR-URL: #13700 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
doc/api/async_hooks.md + L198: Missing code-language flag + L239: Missing code-language flag + L317: Missing code-language flag + L347: Missing code-language flag doc/api/fs.md + L2857: Unused definition PR-URL: #13700 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
doc/api/async_hooks.md + L198: Missing code-language flag + L239: Missing code-language flag + L317: Missing code-language flag + L347: Missing code-language flag doc/api/fs.md + L2857: Unused definition PR-URL: #13700 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
doc/api/async_hooks.md + L198: Missing code-language flag + L239: Missing code-language flag + L317: Missing code-language flag + L347: Missing code-language flag doc/api/fs.md + L2857: Unused definition PR-URL: #13700 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
doc/api/async_hooks.md + L198: Missing code-language flag + L239: Missing code-language flag + L317: Missing code-language flag + L347: Missing code-language flag doc/api/fs.md + L2857: Unused definition PR-URL: #13700 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
doc/api/async_hooks.md + L198: Missing code-language flag + L239: Missing code-language flag + L317: Missing code-language flag + L347: Missing code-language flag doc/api/fs.md + L2857: Unused definition PR-URL: #13700 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
This does not land cleanly in LTS. Please feel free to manually backport by following the guide. Please also feel free to replace do-not-land if it is being backported |
Summary
doc/api/async_hooks.md
doc/api/fs.md
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passesAffected core subsystem(s)
doc